Язык разметки текстов Маркван

Что такое разметка текста

Разметка текста
— это добавление дополнительных символов в текст, дающее возможность передать структуру информации. Например, выделить заголовки, которые разделяют повествование на части, упрощая навигацию по произведению.

Файлы doc, odt, fb2, html и многие другие к которым вы привыкли — это обычные текстовые файлы в которых текст размечен определенным образом, а программы в которых вы их смотрите, этот текст визуализируют. Например вот этот html код:

<p>В этом параграфе есть слово с <strong>жирным</strong> начертанием и <em>курсивом</em>.</p>

В отличии от html аналогичная markvan-разметка выглядит гораздо компактнее и меньше отвлекает от прочтения:

В этом параграфе есть слово с **жирным** начертанием и ``курсивом``.

В браузере этот текст выглядит так:

В этом параграфе есть слово с жирным начертанием и курсивом.

Простой текст это надежность

Основное преимущество использования обычного текста с разметкой — абсолютная доступность ваших данных. Вы всегда сможете открыть и отредактировать текстовый документ независимо от операционной системы и версии программного обеспечения.

Простой текст всегда предпочтительнее иметь в качестве исходника, т.к. форматы приходят и уходят, а текст остается всегда (кодировки не в счёт). Исходный текст можно сконвертировать в любые популярные в данное время форматы.

Назначение markvan

Маркван (мarkvan) — это язык разметки текста предназначенный для фиксирования знаний. Который хорошо подходит для художественной литературы и научных книг, статей, документации. В нём предусмотрено размещение иллюстраций, таблиц, программного кода, формул, вставок аудио, видео и даже нот. Задача маркван-разметки организовывать фрагменты контента с точки зрения иерархии и важности.

Маркван-разметка хорошо считывается визуально и интуитивно понятна. Вы быстро фиксируете свои мысли, четко структурируете их, не задумываясь о шрифтах, размерах, отступах и прочих элементах верстки. Работать можно практически в любых текстовых редакторах различных операционных систем. (Позже появятся плагины к редакторам, которые повысят комфорт от работы с маркван-документами.)

Пример markvan-разметки

***
Это название документа


===
Это заголовок текста

Это обычный текст.
В текст можно добавить изображение:
[[
media/example.jpg (Картинка для примера)
]]

В тексте могут быть выделения слов **жирным** или ``курсивом``.
*-Некий термин-* — и его определение.
Конечно, есть и списки:
 - один
 - два

А вот пример ~[cсылки]~ на какой-нибудь ресурс.
|~ example.com/example

Как видите, всё просто. Разметку несложно запомнить после короткого изучения и небольшой практики.

Как изучить markvan

1. Ознакомьтесь с правилами маркван-разметки. Сразу всё запоминать не обязательно, главное понять принципы.

2. Посмотрите примеры разметки того направления, которое вас интересует.

3. Попробуйте поразмечать свой текст на специальной демонстрационной странице.

После этого можно завести собственный маркван-сайт и уже там полноценно работать над своими произведениями.

Специальные ограничения

Маркван-разметка отражает структуру документа, а не визуальное оформление!

Читателю научной литературы нет необходимости в ярких цветах и котиках на полях, да и читателю художественного произведения незачем отвлекаться на оформительские ухищрения, достаточно традиционных иллюстраций. Опытный читатель в своём воображении увидит весь волшебный мир повествования. Яркие презентации это сфера рекламщиков, которым, зачастую, нет никакого дела до сути. Мы же предлагаем потреблять информацию осознано в индивидуальной визуально комфортной для каждого человека среде.

Маркван имеет достаточные инструменты для качественного представления информации, реализуя основные приемы возникшие в книгопечатании и вобрав в себя современные возможности электронных документов. Маркван разрешает структурную и некоторую смысловую разметку текста, умышленно ограничивая способы указания визуального стиля отображения. Стиль отображения можно задать определенными логически обоснованными правилами при конвертации в другие форматы.

Конвертация в другие форматы

Маркван это базисный человекопонятный формат электронных документов. Из файлов имеющих маркван-разметку можно генерировать документы в требуемом формате для веба, офисных программ, электронных книг.

Маркван намеренно не предоставляет удобный инструмент указания конкретных цветов, шрифтов, стилей — его задача зафиксировать смыслы и структуру произведения. А красивое визуальное оформление создаст программа читателя по его вкусу и текущей моде. При этом сами знания остаются независимыми от обертки!

Фото конфеты в фантике
Красивая обёртка это занятно, но кушаем-то мы конфету!

Индивидуализация отображения

Дополнительный плюс языка разметки текстов markvan в том, что потребитель контента не зависит от предлагаемых ему визуальных стилей оформления. В недалеком будущем читатель сможет скачивать произведения из различных источников, но для него они будут выглядеть в едином стиле, с комфортными для него цветами, шрифтами и отступами.

Конвертация в html

Для размещения произведений в интернете необходимо их конвертировать в html. Написание конвертера относительно несложная задача. И если вы захотите написать свой конвертер, то для вас даже созданы рекомендации по конвертации markvan в html.

Вот достаточно сложный для новичка пример текстовой разметки:

Сравним форматирование и то, что отображается в браузере.
Текст с маркван-форматированием
***
Приключения любознательного кота

Жил да был маленький котенок. Вот такой:
[=
 ^ ^
⋟ᵔᴥᵔ⋞
=]

Хотя, скорее всего, он выглядел так:
[[ Реальная фотография кота
>media/Котик Мио в библиотеке.jpg (Фото котёнка)
]]

Этот кот был удивительно смышлёным и с радостью принимал участие во всяческих авантюрных начинаниях. О чём мы вам и поведаем.


===
Котик-писатель

Как-то раз, сидя на завалинке и перечитывая Артура Конана Дойля, котик подумал: «Если я сказочный кот, то могу и сам книжки писать. И, для начала, мне будет полезно изучить ~[маркван-разметку]~».
|~ /
‹…›


===
Котик-программист

Котик проснулся, потянулся и решил поиграть. Но его маленький хозяин сидел за компьютером и не обращал на него внимания. «Что происходит?», — подумал котик и взобрался мальчику на плечо. На экране компьютера светились страшные буквы:

[&python Пример проверки палиндрома
in_string = 'Зорро — вор роз'

fmt_string = ("".join(c for c in in_string if c.isalpha())).lower()
if fmt_string == fmt_string[::-1]:
	print(f'{in_string} is a palindrome')
else:
	print(f'{in_string} is a NOT palindrome')
&]

‹…›
Вот такой html-код мы можем получить
<h1 class="title">Приключения любознательного кота</h1>
<p>Жил да был маленький котенок. Вот такой:</p>
<figure class="inclusion pre">
	<pre class="incl-body"> ^ ^
⋟ᵔᴥᵔ⋞
		</pre>
</figure>
<p>Хотя, скорее всего, он выглядел так:</p>
<figure class="media">
	<img src="media/Котик Мио в библиотеке.jpg" alt="Фото котёнка">
	<figcaption>
		<h4>Реальная фотография кота</h4>
	</figcaption>
</figure>
<p>Этот кот был удивительно смышлёным и с радостью принимал участие во всяческих авантюрных начинаниях. О чём мы вам и поведаем.</p>
<h2 class="th1">Котик-писатель</h2>
<p>Как-то раз, сидя на завалинке и перечитывая Артура Конана Дойля, котик подумал: «Если я сказочный кот, то могу и сам книжки писать. И, для начала, мне будет полезно изучить <a href="/">маркван-разметку</a>».</p>
<p>‹…›</p>
<h2 class="th1">Котик-программист</h2>
<p>Котик проснулся, потянулся и решил поиграть. Но его маленький хозяин сидел за компьютером и не обращал на него внимания. «Что происходит?», — подумал котик и взобрался мальчику на плечо. На экране компьютера светились страшные буквы:</p>
<figure class="inclusion code python">
	<figcaption>Пример проверки палиндрома</figcaption>
	<code class="incl-body">in_string = 'Зорро — вор роз'

fmt_string = ("".join(c for c in in_string if c.isalpha())).lower()
if fmt_string == fmt_string[::-1]:
	print(f'{in_string} is a palindrome')
else:
	print(f'{in_string} is a NOT palindrome')
		</code>
</figure>
<p>‹…›</p>
Результат html-конвертера в браузере

Приключения любознательного кота

Жил да был маленький котенок. Вот такой:

 ^ ^
⋟ᵔᴥᵔ⋞

Хотя, скорее всего, он выглядел так:

Фото котёнка
Реальная фотография кота

Этот кот был удивительно смышлёным и с радостью принимал участие во всяческих авантюрных начинаниях. О чём мы вам и поведаем.

Котик-писатель

Как-то раз, сидя на завалинке и перечитывая Артура Конана Дойля, котик подумал: «Если я сказочный кот, то могу и сам книжки писать. И, для начала, мне будет полезно изучить маркван-разметку».

‹…›

Котик-программист

Котик проснулся, потянулся и решил поиграть. Но его маленький хозяин сидел за компьютером и не обращал на него внимания. «Что происходит?», — подумал котик и взобрался мальчику на плечо. На экране компьютера светились страшные буквы:

Пример проверки палиндрома
in_string = 'Зорро — вор роз' fmt_string = ("".join(c for c in in_string if c.isalpha())).lower() if fmt_string == fmt_string[::-1]: print(f'{in_string} is a palindrome') else: print(f'{in_string} is a NOT palindrome')

‹…›